Scenario #1201: Update Person Data

Properties

Required

Given

name value
oldFamilyName Matthieu
newFamilyName Matthieu-Zhang

personUuid

HTTP GET "/api/hs/office/persons?name=Matthieu" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
[ {
  "uuid" : "42f2f790-db43-4347-93b9-9b2ef60f3c36", // Person: Michelle Matthieu
  "personType" : "NATURAL_PERSON",
  "tradeName" : null,
  "salutation" : null,
  "title" : null,
  "givenName" : "Michelle",
  "familyName" : "Matthieu"
} ]

In production, data this query could result in multiple outputs. In that case, you have to find out which is the right one.

Patch the Additional Phone-Number into the Person

HTTP PATCH "/api/hs/office/persons/42f2f790-db43-4347-93b9-9b2ef60f3c36" // personUuid \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  -H 'Content-Type: application/json' \
  --data-binary @- <<EOF
{
  "familyName" : "Matthieu-Zhang"
}
EOF
=> status: 200 OK 

Verify that the Family Name Got Amended

HTTP GET "/api/hs/office/persons/42f2f790-db43-4347-93b9-9b2ef60f3c36" // personUuid \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
{
  "uuid" : "42f2f790-db43-4347-93b9-9b2ef60f3c36", // personUuid
  "personType" : "NATURAL_PERSON",
  "tradeName" : null,
  "salutation" : null,
  "title" : null,
  "givenName" : "Michelle",
  "familyName" : "Matthieu-Zhang"
}

generated on 2026-07-17 01:42:26 for branch